Playwright Service API (preview:2025-07-01)

2025/06/26 • 7 new methods

AccessTokens_List (new)
Description :  Lists access-tokens for the given workspace id. It can use OData query params like $select, $filter, $orderby, $top and $skip. The default page size is 10. Use nextLink in response to fetch more objects in the list. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

GET:  /playwrightworkspaces/{workspaceId}/access-tokens
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace id in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of AccessToken items ,
}
{
value:
{
Description: The AccessToken items on this page ,
Required: True ,
}
[
{
id:
{
Description: The access-token id in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_Get (new)
Description :  Gets an access-token for the workspace with given access-token id. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

GET:  /playwrightworkspaces/{workspaceId}/access-tokens/{accessTokenId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace id in GUID format. ,
Required: True ,
}
string ,
accessTokenId:
{
Description: The access-token id in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of an access-token linked to a workspace. ,
}
{
id:
{
Description: The access-token id in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_CreateOrReplace (new)
Description :  Creates an access-token for the workspace with given access-token id. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

PUT:  /playwrightworkspaces/{workspaceId}/access-tokens/{accessTokenId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace id in GUID format. ,
Required: True ,
}
string ,
accessTokenId:
{
Description: The access-token id in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
id:
{
Description: The access-token id in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of an access-token linked to a workspace. ,
}
{
id:
{
Description: The access-token id in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of an access-token linked to a workspace. ,
}
{
id:
{
Description: The access-token id in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_Delete (new)
Description :  Deletes an access-token for the workspace with given access-token id. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

DELETE:  /playwrightworkspaces/{workspaceId}/access-tokens/{accessTokenId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace id in GUID format. ,
Required: True ,
}
string ,
accessTokenId:
{
Description: The access-token id in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Workspaces_GetBrowsers (new)
Description :  Gets remote browsers corresponding to given workspace id and redirects the client for executing Playwright scripts. Authorization required is Bearer JWT Access token provided by EntraID or Playwright Service.
Reference :  Link ¶

⚼ Request

GET:  /playwrightworkspaces/{workspaceId}/browsers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace id in GUID format. ,
Required: True ,
}
string ,
os:
{
Description: The os provided by client for remote script runs. ,
Required: True ,
}
string ,
runId:
{
Description: The runId provided by client in GUID format. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (302)

{
location:
{
Description: The redirect target URL to run script on remote browsers. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TestRuns_List (new)
Description :  Lists test-runs for the given workspace id. It can use OData query params like $filter, $top etc. The default page size is 10. Use nextLink in response to fetch more objects in the list. Authorization required is Bearer JWT Access token provided by EntraID or Playwright Service.
Reference :  Link ¶

⚼ Request

GET:  /playwrightworkspaces/{workspaceId}/test-runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace id in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of TestRun items ,
}
{
value:
{
Description: The TestRun items on this page ,
Required: True ,
}
[
{
id:
{
Description: The test-run id in GUID format. ,
Required: True ,
}
string ,
displayName:
{
Description: The test-run display name. ,
Required: True ,
}
string ,
creatorId:
{
Description: The test-run creator's id. ,
Required: True ,
}
string ,
creatorName:
{
Description: The test-run creator's name. ,
Required: False ,
}
string ,
config:
{
Description: The test-run config. ,
Required: False ,
}
{
framework:
{
Description: The framework used for run. ,
Required: False ,
}
{
name:
{
Description: The framework name. ,
Required: False ,
}
string ,
version:
{
Description: The framework version. ,
Required: False ,
}
string ,
runnerName:
{
Description: The framework runner name. ,
Required: False ,
}
string ,
}
,
sdkLanguage:
{
Description: The SDK Language used for run. ,
Enum:
{
JAVASCRIPT: JAVASCRIPT SDK ,
TYPESCRIPT: TYPESCRIPT SDK ,
CSHARP: CSHARP SDK ,
}
,
Required: False ,
}
enum ,
maxWorkers:
{
Description: The maximum number of workers required for the run. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
ciConfig:
{
Description: The test-run CI Config. ,
Required: False ,
}
{
providerName:
{
Description: The CI provider name. ,
Required: False ,
}
string ,
branch:
{
Description: The CI branch. ,
Required: False ,
}
string ,
author:
{
Description: The CI author. ,
Required: False ,
}
string ,
commitId:
{
Description: The CI commit id. ,
Required: False ,
}
string ,
revisionUrl:
{
Description: The CI revision URL. ,
Required: False ,
}
string ,
}
,
summary:
{
Description: The test-run summary. ,
Required: True ,
}
{
status:
{
Description: The run status. ,
Enum:
{
RUNNING: The run status is RUNNING ,
CLIENT_COMPLETE: The run status is CLIENT_COMPLETE ,
SERVER_COMPLETE: The run status is SERVER_COMPLETE ,
}
,
Required: True ,
}
enum ,
billableTime:
{
Description: The run billable time. ,
Format: int64 ,
Required: False ,
}
integer ,
numBrowserSessions:
{
Description: The total number of browser sessions allocated to the run. ,
Format: int64 ,
Required: False ,
}
integer ,
maxConcurrentBrowserSessions:
{
Description: The highest number of browser sessions that were running at the same time during the run. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: The run start time as utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The run end time as utcDateTime. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The run duration. ,
Format: int64 ,
Required: False ,
}
integer ,
errorMessages:
{
Description: The list of error messages corresponding to the run. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TestRuns_CreateOrUpdate (new)
Description :  Creates/Updates a test-run for the workspace with given test-run id. Authorization required is Bearer JWT Access token provided by EntraID or Playwright Service.
Reference :  Link ¶

⚼ Request

PATCH:  /playwrightworkspaces/{workspaceId}/test-runs/{runId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace id in GUID format. ,
Required: True ,
}
string ,
runId:
{
Description: The test-run id in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
displayName:
{
Description: The test-run display name. ,
Required: False ,
}
string ,
config:
{
Description: The test-run config. ,
Required: False ,
}
{
framework:
{
Description: The framework used for run. ,
Required: False ,
}
{
name:
{
Description: The framework name. ,
Required: False ,
}
string ,
version:
{
Description: The framework version. ,
Required: False ,
}
string ,
runnerName:
{
Description: The framework runner name. ,
Required: False ,
}
string ,
}
,
sdkLanguage:
{
Description: The SDK Language used for run. ,
Enum:
{
JAVASCRIPT: JAVASCRIPT SDK ,
TYPESCRIPT: TYPESCRIPT SDK ,
CSHARP: CSHARP SDK ,
}
,
Required: False ,
}
enum ,
maxWorkers:
{
Description: The maximum number of workers required for the run. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
ciConfig:
{
Description: The test-run CI Config. ,
Required: False ,
}
{
providerName:
{
Description: The CI provider name. ,
Required: False ,
}
string ,
branch:
{
Description: The CI branch. ,
Required: False ,
}
string ,
author:
{
Description: The CI author. ,
Required: False ,
}
string ,
commitId:
{
Description: The CI commit id. ,
Required: False ,
}
string ,
revisionUrl:
{
Description: The CI revision URL. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of a test-run used for tracking purpose. ,
}
{
id:
{
Description: The test-run id in GUID format. ,
Required: True ,
}
string ,
displayName:
{
Description: The test-run display name. ,
Required: True ,
}
string ,
creatorId:
{
Description: The test-run creator's id. ,
Required: True ,
}
string ,
creatorName:
{
Description: The test-run creator's name. ,
Required: False ,
}
string ,
config:
{
Description: The test-run config. ,
Required: False ,
}
{
framework:
{
Description: The framework used for run. ,
Required: False ,
}
{
name:
{
Description: The framework name. ,
Required: False ,
}
string ,
version:
{
Description: The framework version. ,
Required: False ,
}
string ,
runnerName:
{
Description: The framework runner name. ,
Required: False ,
}
string ,
}
,
sdkLanguage:
{
Description: The SDK Language used for run. ,
Enum:
{
JAVASCRIPT: JAVASCRIPT SDK ,
TYPESCRIPT: TYPESCRIPT SDK ,
CSHARP: CSHARP SDK ,
}
,
Required: False ,
}
enum ,
maxWorkers:
{
Description: The maximum number of workers required for the run. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
ciConfig:
{
Description: The test-run CI Config. ,
Required: False ,
}
{
providerName:
{
Description: The CI provider name. ,
Required: False ,
}
string ,
branch:
{
Description: The CI branch. ,
Required: False ,
}
string ,
author:
{
Description: The CI author. ,
Required: False ,
}
string ,
commitId:
{
Description: The CI commit id. ,
Required: False ,
}
string ,
revisionUrl:
{
Description: The CI revision URL. ,
Required: False ,
}
string ,
}
,
summary:
{
Description: The test-run summary. ,
Required: True ,
}
{
status:
{
Description: The run status. ,
Enum:
{
RUNNING: The run status is RUNNING ,
CLIENT_COMPLETE: The run status is CLIENT_COMPLETE ,
SERVER_COMPLETE: The run status is SERVER_COMPLETE ,
}
,
Required: True ,
}
enum ,
billableTime:
{
Description: The run billable time. ,
Format: int64 ,
Required: False ,
}
integer ,
numBrowserSessions:
{
Description: The total number of browser sessions allocated to the run. ,
Format: int64 ,
Required: False ,
}
integer ,
maxConcurrentBrowserSessions:
{
Description: The highest number of browser sessions that were running at the same time during the run. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: The run start time as utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The run end time as utcDateTime. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The run duration. ,
Format: int64 ,
Required: False ,
}
integer ,
errorMessages:
{
Description: The list of error messages corresponding to the run. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of a test-run used for tracking purpose. ,
}
{
id:
{
Description: The test-run id in GUID format. ,
Required: True ,
}
string ,
displayName:
{
Description: The test-run display name. ,
Required: True ,
}
string ,
creatorId:
{
Description: The test-run creator's id. ,
Required: True ,
}
string ,
creatorName:
{
Description: The test-run creator's name. ,
Required: False ,
}
string ,
config:
{
Description: The test-run config. ,
Required: False ,
}
{
framework:
{
Description: The framework used for run. ,
Required: False ,
}
{
name:
{
Description: The framework name. ,
Required: False ,
}
string ,
version:
{
Description: The framework version. ,
Required: False ,
}
string ,
runnerName:
{
Description: The framework runner name. ,
Required: False ,
}
string ,
}
,
sdkLanguage:
{
Description: The SDK Language used for run. ,
Enum:
{
JAVASCRIPT: JAVASCRIPT SDK ,
TYPESCRIPT: TYPESCRIPT SDK ,
CSHARP: CSHARP SDK ,
}
,
Required: False ,
}
enum ,
maxWorkers:
{
Description: The maximum number of workers required for the run. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
ciConfig:
{
Description: The test-run CI Config. ,
Required: False ,
}
{
providerName:
{
Description: The CI provider name. ,
Required: False ,
}
string ,
branch:
{
Description: The CI branch. ,
Required: False ,
}
string ,
author:
{
Description: The CI author. ,
Required: False ,
}
string ,
commitId:
{
Description: The CI commit id. ,
Required: False ,
}
string ,
revisionUrl:
{
Description: The CI revision URL. ,
Required: False ,
}
string ,
}
,
summary:
{
Description: The test-run summary. ,
Required: True ,
}
{
status:
{
Description: The run status. ,
Enum:
{
RUNNING: The run status is RUNNING ,
CLIENT_COMPLETE: The run status is CLIENT_COMPLETE ,
SERVER_COMPLETE: The run status is SERVER_COMPLETE ,
}
,
Required: True ,
}
enum ,
billableTime:
{
Description: The run billable time. ,
Format: int64 ,
Required: False ,
}
integer ,
numBrowserSessions:
{
Description: The total number of browser sessions allocated to the run. ,
Format: int64 ,
Required: False ,
}
integer ,
maxConcurrentBrowserSessions:
{
Description: The highest number of browser sessions that were running at the same time during the run. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: The run start time as utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The run end time as utcDateTime. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The run duration. ,
Format: int64 ,
Required: False ,
}
integer ,
errorMessages:
{
Description: The list of error messages corresponding to the run. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}